<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
<!-- qaccessible.cpp -->
  <title>QAccessibleActionInterface Class | Qt GUI 5.14.2</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td ><a href="../qtdoc/index.html">Qt 5.14</a></td><td ><a href="qtgui-index.html">Qt GUI</a></td><td ><a href="qtgui-module.html">C++ Classes</a></td><td >QAccessibleActionInterface</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtgui-index.html">Qt 5.14.2 Reference Documentation</a></td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QAccessibleActionInterface Class</h1>
<!-- $$$QAccessibleActionInterface-brief -->
<p>The QAccessibleActionInterface class implements support for invocable actions in the interface. <a href="#details">More...</a></p>
<!-- @@@QAccessibleActionInterface -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QAccessibleActionInterface&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += gui</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="../qtwidgets/qaccessiblewidget.html">QAccessibleWidget</a></p>
</td></tr></table></div><ul>
<li><a href="qaccessibleactioninterface-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qaccessibleactioninterface.html#dtor.QAccessibleActionInterface">~QAccessibleActionInterface</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QStringList </td><td class="memItemRight bottomAlign"><b><a href="qaccessibleactioninterface.html#actionNames">actionNames</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qaccessibleactioninterface.html#doAction">doAction</a></b>(const QString &amp;<i>actionName</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QStringList </td><td class="memItemRight bottomAlign"><b><a href="qaccessibleactioninterface.html#keyBindingsForAction">keyBindingsForAction</a></b>(const QString &amp;<i>actionName</i>) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qaccessibleactioninterface.html#localizedActionDescription">localizedActionDescription</a></b>(const QString &amp;<i>actionName</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qaccessibleactioninterface.html#localizedActionName">localizedActionName</a></b>(const QString &amp;<i>actionName</i>) const</td></tr>
</table></div>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QString &amp;</td><td class="memItemRight bottomAlign"><b><a href="qaccessibleactioninterface.html#decreaseAction">decreaseAction</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QString &amp;</td><td class="memItemRight bottomAlign"><b><a href="qaccessibleactioninterface.html#increaseAction">increaseAction</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qaccessibleactioninterface.html#nextPageAction">nextPageAction</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QString &amp;</td><td class="memItemRight bottomAlign"><b><a href="qaccessibleactioninterface.html#pressAction">pressAction</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qaccessibleactioninterface.html#previousPageAction">previousPageAction</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qaccessibleactioninterface.html#scrollDownAction">scrollDownAction</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qaccessibleactioninterface.html#scrollLeftAction">scrollLeftAction</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qaccessibleactioninterface.html#scrollRightAction">scrollRightAction</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qaccessibleactioninterface.html#scrollUpAction">scrollUpAction</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QString &amp;</td><td class="memItemRight bottomAlign"><b><a href="qaccessibleactioninterface.html#setFocusAction">setFocusAction</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QString &amp;</td><td class="memItemRight bottomAlign"><b><a href="qaccessibleactioninterface.html#showMenuAction">showMenuAction</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QString &amp;</td><td class="memItemRight bottomAlign"><b><a href="qaccessibleactioninterface.html#toggleAction">toggleAction</a></b>()</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QAccessibleActionInterface-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>Accessible objects should implement the action interface if they support user interaction. Usually this interface is implemented by classes that also implement <a href="qaccessibleinterface.html">QAccessibleInterface</a>.</p>
<p>The supported actions should use the predefined actions offered in this class unless they do not fit a predefined action. In that case a custom action can be added.</p>
<p>When subclassing QAccessibleActionInterface you need to provide a list of <a href="qaccessibleactioninterface.html#actionNames">actionNames</a> which is the primary means to discover the available actions. Action names are never localized. In order to present actions to the user there are two functions that need to return localized versions of the name and give a description of the action. For the predefined action names use <a href="qaccessibleactioninterface.html#localizedActionName">QAccessibleActionInterface::localizedActionName</a>() and <a href="qaccessibleactioninterface.html#localizedActionDescription">QAccessibleActionInterface::localizedActionDescription</a>() to return their localized counterparts.</p>
<p>In general you should use one of the predefined action names, unless describing an action that does not fit these:</p>
<div class="table"><table class="generic">
 <thead><tr class="qt-style"><th >Action name</th><th >Description</th></tr></thead>
<tr valign="top" class="odd"><td ><a href="qaccessibleactioninterface.html#toggleAction">toggleAction</a>()</td><td >toggles the item (checkbox, radio button, switch, ..&#x2e;)</td></tr>
<tr valign="top" class="even"><td ><a href="qaccessibleactioninterface.html#decreaseAction">decreaseAction</a>()</td><td >decrease the value of the accessible (e.g&#x2e; spinbox)</td></tr>
<tr valign="top" class="odd"><td ><a href="qaccessibleactioninterface.html#increaseAction">increaseAction</a>()</td><td >increase the value of the accessible (e.g&#x2e; spinbox)</td></tr>
<tr valign="top" class="even"><td ><a href="qaccessibleactioninterface.html#pressAction">pressAction</a>()</td><td >press or click or activate the accessible (should correspont to clicking the object with the mouse)</td></tr>
<tr valign="top" class="odd"><td ><a href="qaccessibleactioninterface.html#setFocusAction">setFocusAction</a>()</td><td >set the focus to this accessible</td></tr>
<tr valign="top" class="even"><td ><a href="qaccessibleactioninterface.html#showMenuAction">showMenuAction</a>()</td><td >show a context menu, corresponds to right-clicks</td></tr>
</table></div>
<p>In order to invoke the action, <a href="qaccessibleactioninterface.html#doAction">doAction</a>() is called with an action name.</p>
<p>Most widgets will simply implement <a href="qaccessibleactioninterface.html#pressAction">pressAction</a>(). This is what happens when the widget is activated by being clicked, space pressed or similar.</p>
<p><a href="http://www.linux-foundation.org/en/Accessibility/IAccessible2">IAccessible2 Specification</a></p>
</div>
<!-- @@@QAccessibleActionInterface -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$~QAccessibleActionInterface[overload1]$$$~QAccessibleActionInterface -->
<h3 class="fn" id="dtor.QAccessibleActionInterface"><a name="dtor.QAccessibleActionInterface"></a><code>[virtual] </code>QAccessibleActionInterface::<span class="name">~QAccessibleActionInterface</span>()</h3>
<p>Destroys the <a href="qaccessibleactioninterface.html">QAccessibleActionInterface</a>.</p>
<!-- @@@~QAccessibleActionInterface -->
<!-- $$$actionNames[overload1]$$$actionNames -->
<h3 class="fn" id="actionNames"><a name="actionNames"></a><code>[pure virtual] </code><span class="type"><a href="../qtcore/qstringlist.html">QStringList</a></span> QAccessibleActionInterface::<span class="name">actionNames</span>() const</h3>
<p>Returns the list of actions supported by this accessible object. The actions returned should be in preferred order, i.e&#x2e; the action that the user most likely wants to trigger should be returned first, while the least likely action should be returned last.</p>
<p>The list does only contain actions that can be invoked. It won't return disabled actions, or actions associated with disabled UI controls.</p>
<p>The list can be empty.</p>
<p>Note that this list is not localized. For a localized representation re-implement <a href="qaccessibleactioninterface.html#localizedActionName">localizedActionName</a>() and <a href="qaccessibleactioninterface.html#localizedActionDescription">localizedActionDescription</a>()</p>
<p><b>See also </b><a href="qaccessibleactioninterface.html#doAction">doAction</a>(), <a href="qaccessibleactioninterface.html#localizedActionName">localizedActionName</a>(), and <a href="qaccessibleactioninterface.html#localizedActionDescription">localizedActionDescription</a>().</p>
<!-- @@@actionNames -->
<!-- $$$decreaseAction[overload1]$$$decreaseAction -->
<h3 class="fn" id="decreaseAction"><a name="decreaseAction"></a><code>[static] </code>const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &amp;QAccessibleActionInterface::<span class="name">decreaseAction</span>()</h3>
<p>Returns the name of the decrease default action.</p>
<p><b>See also </b><a href="qaccessibleactioninterface.html#actionNames">actionNames</a>() and <a href="qaccessibleactioninterface.html#localizedActionName">localizedActionName</a>().</p>
<!-- @@@decreaseAction -->
<!-- $$$doAction[overload1]$$$doActionconstQString& -->
<h3 class="fn" id="doAction"><a name="doAction"></a><code>[pure virtual] </code><span class="type">void</span> QAccessibleActionInterface::<span class="name">doAction</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &amp;<i>actionName</i>)</h3>
<p>Invokes the action specified by <i>actionName</i>. Note that <i>actionName</i> is the non-localized name as returned by <a href="qaccessibleactioninterface.html#actionNames">actionNames</a>() This function is usually implemented by calling the same functions that other user interaction, such as clicking the object, would trigger.</p>
<p><b>See also </b><a href="qaccessibleactioninterface.html#actionNames">actionNames</a>().</p>
<!-- @@@doAction -->
<!-- $$$increaseAction[overload1]$$$increaseAction -->
<h3 class="fn" id="increaseAction"><a name="increaseAction"></a><code>[static] </code>const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &amp;QAccessibleActionInterface::<span class="name">increaseAction</span>()</h3>
<p>Returns the name of the increase default action.</p>
<p><b>See also </b><a href="qaccessibleactioninterface.html#actionNames">actionNames</a>() and <a href="qaccessibleactioninterface.html#localizedActionName">localizedActionName</a>().</p>
<!-- @@@increaseAction -->
<!-- $$$keyBindingsForAction[overload1]$$$keyBindingsForActionconstQString& -->
<h3 class="fn" id="keyBindingsForAction"><a name="keyBindingsForAction"></a><code>[pure virtual] </code><span class="type"><a href="../qtcore/qstringlist.html">QStringList</a></span> QAccessibleActionInterface::<span class="name">keyBindingsForAction</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &amp;<i>actionName</i>) const</h3>
<p>Returns a list of the keyboard shortcuts available for invoking the action named <i>actionName</i>.</p>
<p>This is important to let users learn alternative ways of using the application by emphasizing the keyboard.</p>
<p><b>See also </b><a href="qaccessibleactioninterface.html#actionNames">actionNames</a>().</p>
<!-- @@@keyBindingsForAction -->
<!-- $$$localizedActionDescription[overload1]$$$localizedActionDescriptionconstQString& -->
<h3 class="fn" id="localizedActionDescription"><a name="localizedActionDescription"></a><code>[virtual] </code><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QAccessibleActionInterface::<span class="name">localizedActionDescription</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &amp;<i>actionName</i>) const</h3>
<p>Returns a localized action description of the action <i>actionName</i>.</p>
<p>When using one of the default names, you can call this function in <a href="qaccessibleactioninterface.html">QAccessibleActionInterface</a> to get the localized string.</p>
<p><b>See also </b><a href="qaccessibleactioninterface.html#actionNames">actionNames</a>() and <a href="qaccessibleactioninterface.html#localizedActionName">localizedActionName</a>().</p>
<!-- @@@localizedActionDescription -->
<!-- $$$localizedActionName[overload1]$$$localizedActionNameconstQString& -->
<h3 class="fn" id="localizedActionName"><a name="localizedActionName"></a><code>[virtual] </code><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QAccessibleActionInterface::<span class="name">localizedActionName</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &amp;<i>actionName</i>) const</h3>
<p>Returns a localized action name of <i>actionName</i>.</p>
<p>For custom actions this function has to be re-implemented. When using one of the default names, you can call this function in <a href="qaccessibleactioninterface.html">QAccessibleActionInterface</a> to get the localized string.</p>
<p><b>See also </b><a href="qaccessibleactioninterface.html#actionNames">actionNames</a>() and <a href="qaccessibleactioninterface.html#localizedActionDescription">localizedActionDescription</a>().</p>
<!-- @@@localizedActionName -->
<!-- $$$nextPageAction[overload1]$$$nextPageAction -->
<h3 class="fn" id="nextPageAction"><a name="nextPageAction"></a><code>[static] </code><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QAccessibleActionInterface::<span class="name">nextPageAction</span>()</h3>
<p>Returns the name of the next page default action.</p>
<p><b>See also </b><a href="qaccessibleactioninterface.html#actionNames">actionNames</a>() and <a href="qaccessibleactioninterface.html#localizedActionName">localizedActionName</a>().</p>
<!-- @@@nextPageAction -->
<!-- $$$pressAction[overload1]$$$pressAction -->
<h3 class="fn" id="pressAction"><a name="pressAction"></a><code>[static] </code>const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &amp;QAccessibleActionInterface::<span class="name">pressAction</span>()</h3>
<p>Returns the name of the press default action.</p>
<p><b>See also </b><a href="qaccessibleactioninterface.html#actionNames">actionNames</a>() and <a href="qaccessibleactioninterface.html#localizedActionName">localizedActionName</a>().</p>
<!-- @@@pressAction -->
<!-- $$$previousPageAction[overload1]$$$previousPageAction -->
<h3 class="fn" id="previousPageAction"><a name="previousPageAction"></a><code>[static] </code><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QAccessibleActionInterface::<span class="name">previousPageAction</span>()</h3>
<p>Returns the name of the previous page default action.</p>
<p><b>See also </b><a href="qaccessibleactioninterface.html#actionNames">actionNames</a>() and <a href="qaccessibleactioninterface.html#localizedActionName">localizedActionName</a>().</p>
<!-- @@@previousPageAction -->
<!-- $$$scrollDownAction[overload1]$$$scrollDownAction -->
<h3 class="fn" id="scrollDownAction"><a name="scrollDownAction"></a><code>[static] </code><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QAccessibleActionInterface::<span class="name">scrollDownAction</span>()</h3>
<p>Returns the name of the scroll down default action.</p>
<p><b>See also </b><a href="qaccessibleactioninterface.html#actionNames">actionNames</a>() and <a href="qaccessibleactioninterface.html#localizedActionName">localizedActionName</a>().</p>
<!-- @@@scrollDownAction -->
<!-- $$$scrollLeftAction[overload1]$$$scrollLeftAction -->
<h3 class="fn" id="scrollLeftAction"><a name="scrollLeftAction"></a><code>[static] </code><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QAccessibleActionInterface::<span class="name">scrollLeftAction</span>()</h3>
<p>Returns the name of the scroll left default action.</p>
<p><b>See also </b><a href="qaccessibleactioninterface.html#actionNames">actionNames</a>() and <a href="qaccessibleactioninterface.html#localizedActionName">localizedActionName</a>().</p>
<!-- @@@scrollLeftAction -->
<!-- $$$scrollRightAction[overload1]$$$scrollRightAction -->
<h3 class="fn" id="scrollRightAction"><a name="scrollRightAction"></a><code>[static] </code><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QAccessibleActionInterface::<span class="name">scrollRightAction</span>()</h3>
<p>Returns the name of the scroll right default action.</p>
<p><b>See also </b><a href="qaccessibleactioninterface.html#actionNames">actionNames</a>() and <a href="qaccessibleactioninterface.html#localizedActionName">localizedActionName</a>().</p>
<!-- @@@scrollRightAction -->
<!-- $$$scrollUpAction[overload1]$$$scrollUpAction -->
<h3 class="fn" id="scrollUpAction"><a name="scrollUpAction"></a><code>[static] </code><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QAccessibleActionInterface::<span class="name">scrollUpAction</span>()</h3>
<p>Returns the name of the scroll up default action.</p>
<p><b>See also </b><a href="qaccessibleactioninterface.html#actionNames">actionNames</a>() and <a href="qaccessibleactioninterface.html#localizedActionName">localizedActionName</a>().</p>
<!-- @@@scrollUpAction -->
<!-- $$$setFocusAction[overload1]$$$setFocusAction -->
<h3 class="fn" id="setFocusAction"><a name="setFocusAction"></a><code>[static] </code>const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &amp;QAccessibleActionInterface::<span class="name">setFocusAction</span>()</h3>
<p>Returns the name of the set focus default action.</p>
<p><b>See also </b><a href="qaccessibleactioninterface.html#actionNames">actionNames</a>() and <a href="qaccessibleactioninterface.html#localizedActionName">localizedActionName</a>().</p>
<!-- @@@setFocusAction -->
<!-- $$$showMenuAction[overload1]$$$showMenuAction -->
<h3 class="fn" id="showMenuAction"><a name="showMenuAction"></a><code>[static] </code>const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &amp;QAccessibleActionInterface::<span class="name">showMenuAction</span>()</h3>
<p>Returns the name of the show menu default action.</p>
<p><b>See also </b><a href="qaccessibleactioninterface.html#actionNames">actionNames</a>() and <a href="qaccessibleactioninterface.html#localizedActionName">localizedActionName</a>().</p>
<!-- @@@showMenuAction -->
<!-- $$$toggleAction[overload1]$$$toggleAction -->
<h3 class="fn" id="toggleAction"><a name="toggleAction"></a><code>[static] </code>const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &amp;QAccessibleActionInterface::<span class="name">toggleAction</span>()</h3>
<p>Returns the name of the toggle default action.</p>
<p><b>See also </b><a href="qaccessibleactioninterface.html#actionNames">actionNames</a>() and <a href="qaccessibleactioninterface.html#localizedActionName">localizedActionName</a>().</p>
<!-- @@@toggleAction -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2020 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br/>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>
